<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Viewer</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: Viewer</h1>

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>Viewer<span class="signature">(parameters<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    

    
    <h4 class="name" id="Viewer"><span class="type-signature"></span>new Viewer<span class="signature">(parameters<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
    

    
    <p class="summary">BIMRUN JavaScript引擎 版本3.7，由之前的BIMRUN v3.6，BimViewer等版本重构演化而来，目的在于优化架构、减少代码复杂度，以及一些其他特性来提升性能等。集成的一些功能和特性：WebGL2.0，遮挡剔除，事件监听机制，多种picking方式，优化后的操控，几何压缩模式，纯色模式，边线模式，自定义物体、热力图、轴网、电子围栏，并加强了一些可扩展性。为尽量减轻使用者的负担，除了一些单独的类以外，几乎所有的api方法都在viewer上直接调用和设置。</p>
    



<div class="description">
    BIMRUN Viewer V3.7
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parameters</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last">
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>container</code></td>
            

            <td class="type">
            
                
<span class="param-type">domElement</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {undefined}
                
                </td>
            

            <td class="description last">引擎初始化依赖的父级dom容器，若传入空值则自动创建，挂载在Viewer.container对象下</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>cullRatio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0.02
                
                </td>
            

            <td class="description last">设置cullRatio</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxExtentSize</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1048576
                
                </td>
            

            <td class="description last">设置maxExtentSize</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minExtentSize</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0.5
                
                </td>
            

            <td class="description last">设置minExtentSize</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>looseRatio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1.2
                
                </td>
            

            <td class="description last">设置looseRatio</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxMemory</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    3221225472 (3GB)
                
                </td>
            

            <td class="description last">设置引擎最大可用内存，当引擎的内存占用超过此值时会主动进行内存释放，单位：byte</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>webglVer</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    "2.0"
                
                </td>
            

            <td class="description last">设置使用的WebGL版本，示例："1.0"||"2.0"，注意：在某些iOS版本以及浏览器内核上（微信、Chrome）目前还不支持WebGL2.0因此需要手动设置此参数为"1.0"</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minFPS</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    30
                
                </td>
            

            <td class="description last">设置引擎在加载过程中的最低帧数，范围1-60</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>castShadow</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">是否开启阴影</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minimap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">是否开启小地图（未实现）</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>compression</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">是否开启压缩模式</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>loadTexture</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">是否加载贴图</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>renderClipCap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">是否在剖切时进行反面渲染</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>edge</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">是否开启边线渲染</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>edgeColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0x888888
                
                </td>
            

            <td class="description last">设置边线渲染颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>isolatedColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0x808080
                
                </td>
            

            <td class="description last">设置隔离模型的颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>selectedColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0x0000a0
                
                </td>
            

            <td class="description last">设置选中模型的颜色</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>logDepth</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">是否启用log深度计算方式，注意：经测试，在当前iOS设备上只有Safari浏览器可以正常显示logDepth下的模型，因此其他的iOS浏览器（微信浏览器、Chrome等）环境下请关闭此选项</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>usePackDown</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">是否使用打包下载模型的方式，推荐开启以减少碎片下载请求。注意：在读取本地离线模型文件（单个.ogl文件）时，需要将此参数设置为false</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>indicator</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {undefined}
                
                </td>
            

            <td class="description last">设置鼠标操控指示器的图片和大小，示例：{ url: "./resource/aim.png", size: 1 }
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">图片地址，示例："./resource/aim.png"</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>size</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">图片大小，示例：1</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    
    <dt class="tag-author">Author:</dt>
    <dd class="tag-author">
        <ul>
            <li>Yao Yuan, Mao Weiqing @SUIT</li>
        </ul>
    </dd>
    

    

    

    

    

    

    

    
</dl>




















    
    </div>

    

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id="capabilities"><span class="type-signature"></span>capabilities<span class="type-signature"> :Object</span></h4>




<div class="description">
    capabilities 对象中存储了当前运行平台上的WebGL相关能力状态
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="controls-%3EupdatePickSprite"><span class="type-signature"></span>controls->updatePickSprite<span class="type-signature"> :function</span></h4>




<div class="description">
    设置zoom时，在鼠标处显示的sprite样式
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">function</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>后续版本中将弃用，推荐在new Viewer(parameters)时，以参数形式传入，或使用Viewer.updatePickSprite()方法</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="domElements"><span class="type-signature"></span>domElements<span class="type-signature"> :Object</span></h4>




<div class="description">
    domElements 对象中存储了Viewer中使用到的dom元素
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="envEffects"><span class="type-signature"></span>envEffects<span class="type-signature"> :<a href="EnvEffectsPlugin.html">EnvEffectsPlugin</a></span></h4>




<div class="description">
    实现动态环境效果的插件对象，包含相关方法，请至该类详情页查看。
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="EnvEffectsPlugin.html">EnvEffectsPlugin</a></span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="isMobile"><span class="type-signature"></span>isMobile<span class="type-signature"> :Boolean</span></h4>




<div class="description">
    引擎是否运行在移动端模式下
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="parameters"><span class="type-signature"></span>parameters<span class="type-signature"> :Object</span></h4>




<div class="description">
    保存Viewer各项参数的对象，该对象下特定的属性可以在Viewer运行时动态修改并及时生效。
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="PICKING_INTERVAL_THRES"><span class="type-signature"></span>PICKING_INTERVAL_THRES<span class="type-signature"> :Number</span></h4>




<div class="description">
    鼠标点击选中模型的最大时间间隔
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="scene-%3Ebackground"><span class="type-signature"></span>scene->background<span class="type-signature"> :Number</span></h4>




<div class="description">
    设置场景的背景颜色
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>后续版本中将弃用，推荐使用 Viewer.setSceneBackgroundColor() 或者 Viewer.setSceneBackgroundTexture()</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="walkThrough"><span class="type-signature"></span>walkThrough<span class="type-signature"> :<a href="WalkThroughPlugin.html">WalkThroughPlugin</a></span></h4>




<div class="description">
    实现漫游功能的插件，包含相关方法，请至该类详情页查看。
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="WalkThroughPlugin.html">WalkThroughPlugin</a></span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="addClippingBox"><span class="type-signature"></span>addClippingBox<span class="signature">(center, width, height, depth, xAxis, yAxis, zAxis, color, alpha)</span><span class="type-signature"> &rarr; {Array.&lt;ClippingPlane>}</span></h4>
    

    



<div class="description">
    添加剖切盒
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>center</code></td>
            

            <td class="type">
            
                
<span class="param-type">Vector3</span>


            
            </td>

            

            

            <td class="description last">{ x: float, y: float, z: float }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>depth</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>xAxis</code></td>
            

            <td class="type">
            
                
<span class="param-type">Vector3</span>


            
            </td>

            

            

            <td class="description last">{ x: float, y: float, z: float }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>yAxis</code></td>
            

            <td class="type">
            
                
<span class="param-type">Vector3</span>


            
            </td>

            

            

            <td class="description last">{ x: float, y: float, z: float }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zAxis</code></td>
            

            <td class="type">
            
                
<span class="param-type">Vector3</span>


            
            </td>

            

            

            <td class="description last">{ x: float, y: float, z: float }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">Color</span>
|

<span class="param-type">hex</span>
|

<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">0xffffff</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>alpha</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last">0.0 - 1.0</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    ClippingPlanes
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;ClippingPlane></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="addClippingPlane"><span class="type-signature"></span>addClippingPlane<span class="signature">(center, normal, width, height, color, alpha)</span><span class="type-signature"> &rarr; {ClippingPlane}</span></h4>
    

    



<div class="description">
    添加剖切平面
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>center</code></td>
            

            <td class="type">
            
                
<span class="param-type">Vector3</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>normal</code></td>
            

            <td class="type">
            
                
<span class="param-type">Vector3</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">Color</span>
|

<span class="param-type">hex</span>
|

<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>alpha</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">ClippingPlane</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="addCustomBasicLine"><span class="type-signature"></span>addCustomBasicLine<span class="signature">(points, color, width)</span><span class="type-signature"> &rarr; {Line}</span></h4>
    

    



<div class="description">
    在场景中添加基本线条
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            
            </td>

            

            

            <td class="description last">[{x:0, y:0, z:0}, ...]</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">十六进制数 例如：0xff00ff</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">Due to limitations of the OpenGL Core Profile with the WebGL renderer on most platforms linewidth will always be 1 regardless of the set value.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Line</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="addCustomDashedLine"><span class="type-signature"></span>addCustomDashedLine<span class="signature">(points, color, width, scale, dashSize, gapSize)</span><span class="type-signature"> &rarr; {Line}</span></h4>
    

    



<div class="description">
    在场景中添加虚线条
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            
            </td>

            

            

            <td class="description last">[{x:0, y:0, z:0}, ...]</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">十六进制数 例如：0xff00ff</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">Due to limitations of the OpenGL Core Profile with the WebGL renderer on most platforms linewidth will always be 1 regardless of the set value.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>scale</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">The scale of the dashed part of a line. Default is 1.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dashSize</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">The size of the dash. This is both the gap with the stroke. Default is 3.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>gapSize</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">The size of the gap. Default is 1.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Line</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="addCustomObject"><span class="type-signature"></span>addCustomObject<span class="signature">(obj)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    添加用户自定义模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Object3D</span>


            
            </td>

            

            

            <td class="description last">本方法接收任何three.js的可渲染对象，可以是 Mesh，LineSegments，Object3D等，外部模型可通过利用three.js的loader进行加载后传入</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="addDom"><span class="type-signature"></span>addDom<span class="signature">(dom, position, eventEnable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    添加css2drenderer 的dom元素
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>dom</code></td>
            

            <td class="type">
            
                
<span class="param-type">DOM</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>eventEnable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="addParticleEffects"><span class="type-signature"></span>addParticleEffects<span class="signature">(particleEffects)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    添加粒子效果
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>particleEffects</code></td>
            

            <td class="type">
            
                
<span class="param-type">BIMRUN.ParticleSystem.ParticleEffect</span>
|

<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">输入的例子效果，需要手动进行创建后传入，可接受直接传入或以数组形式传入多个</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="addQRCode"><span class="type-signature"></span>addQRCode<span class="signature">(position, quaternion)</span><span class="type-signature"> &rarr; {BimrunQRCode}</span></h4>
    

    



<div class="description">
    根据已有的位置(position)和旋转(quaternion)数据，来创建并显示二维码模型
<br>你可以将返回的二维码对象加入到你的队列中去保存该对象，用来后面的旋转，平移，显示和隐藏，以及删除该二维码对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">二维码模型的地址 {x: 0.0, y: 0.0, z: 0.0 }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>quaternion</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">二维码模型旋转参数 {x:0.0, y:0.0, z:0.0, w:1.0}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    返回值为二维码对象
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">BimrunQRCode</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="addSelection"><span class="type-signature"></span>addSelection<span class="signature">(sceneModels)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    为模型添加选中样式,同时触发selectionChanged事件
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneModels</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


            
            </td>

            

            

            <td class="description last">[sceneModels] 以数组形式传入</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="addSpritesSubContainer"><span class="type-signature"></span>addSpritesSubContainer<span class="signature">()</span><span class="type-signature"> &rarr; {SpriteContainer}</span></h4>
    

    



<div class="description">
    创建点精灵容器
调用该方法将会返回一个SpriteContainer容器对象，该对象上有以下几个方法：deleteAllSprites(), deleteSprites([sprite]), show(), hide(), setSpriteTargetRadius(sprite, factor)，方法详情可以参考SpriteContainer类页面
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">SpriteContainer</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="adjustCameraByModels"><span class="type-signature"></span>adjustCameraByModels<span class="signature">(models)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    通过模型来调整相机位置
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>models</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="adjustCameraBySceneIds"><span class="type-signature"></span>adjustCameraBySceneIds<span class="signature">(ids, duration)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
    

    



<div class="description">
    通过场景id来调整相机位置
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ids</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;ids></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选)单位：ms  默认值： 2000ms</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    结果是否成功
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="attachTransformControls"><span class="type-signature"></span>attachTransformControls<span class="signature">(object)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    为场景中的3D对象添加控制器，会显示出操纵柄，从而控制该物体在3维场景中的平移和旋转
<br>注意场景中同时只能存在一个控制器去连接三维对象，也就是说，当你连接过一个对象后，再次调用该函数去连接另一个对象时，原先连接物体的控制器将会自动解除
<br>并不是场景中所有的三维物体可以被连接，目前只支持自定义的三维对象，如二维码对象等，而场景本身的模型是不能被连接的。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>object</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">自定义的三维对象，包括二维码对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    清除Viewer的所有内部数据和内存空间，返回为初始化时的状态。
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="clearModelCustomColor"><span class="type-signature"></span>clearModelCustomColor<span class="signature">(modelIds)</span><span class="type-signature"> &rarr; {Array.&lt;Number>}</span></h4>
    

    



<div class="description">
    清除模型的自定义的颜色
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last"><b>可选参数（optional）：</b>如果不传，则清除所有有自定义颜色模型的自定义颜色
<br> modelIds 以数组形式传入的models的id,清除传入的modelId对应的模型的自定义颜色</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    changedIds：已清除的模型id数组
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;Number></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="clearSelection"><span class="type-signature"></span>clearSelection<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    清除所有模型的选中样式
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="closeToPoint"><span class="type-signature"></span>closeToPoint<span class="signature">(point, duration, awayDistance)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    相机飞向一个点
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选) 单位：ms  默认值： 2000ms</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>awayDistance</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选) 设置相机是否飞向距离目的地一定距离的点，默认值：0</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createCube"><span class="type-signature"></span>createCube<span class="signature">(domElement, cssStyle)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    创建引擎的导航指示器
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>domElement</code></td>
            

            <td class="type">
            
                
<span class="param-type">DOM</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>cssStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>在下个更新版本中将被弃用，请使用Viewer.createNavCube()</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createCustomObjectAnimation"><span class="type-signature"></span>createCustomObjectAnimation<span class="signature">(obj, mixInfo, durationArray)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    利用创建的object，以及位置、方向信息去构造一个动画
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Object3D</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mixInfo</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            
            </td>

            

            

            <td class="description last">[{position: {x:0, y:0, z:0}, quaternion: {x:1, y: 0, z:0, w: 0}, angle:{x:0, y:Math.PI/3, z: 0}}, ... ]
<br> angle和quaternion只需要传入任何一个，都表示角度的旋转
<br> angle的x,y,z 分别是绕x,y,z轴旋转的角度,单位弧度制,(Math.PI/2)
<br> 注意：当quaternion 和angle同时传入的时候，会优先使用angle</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>durationArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">需要和mixInfo的数组长度相同，[0, 1000, 2000], 表示有三个数据点，共两段时间，分别是1000ms和2000ms</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    返回的对象上包含对该物体以及动画的控制方法， 包括start(), pause(), stop(), resume()， repeat()， 以及两个动画状态相关的方法，isPlaying(), isPaused()
</div>



    





        
            

    

    
    <h4 class="name" id="createCustomSceneGridlines"><span class="type-signature"></span>createCustomSceneGridlines<span class="signature">(sceneId, levelsId, userData)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    在场景中利用用户传入的数据来创建轴线
注意：你需要先调用加载轴线字体的方法，在加载成功之后会返回promise对象，在promise.then方法中调用该方法
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>levelsId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">levelId，注意以数组形式传入, 如果不传，则创建该sceneId场景下所有的标高对应的轴线</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>userData</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{levels:[{}], gridLines: [{}]}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createFence"><span class="type-signature"></span>createFence<span class="signature">(points, minZ, maxZ, parameters)</span><span class="type-signature"> &rarr; {<a href="Fence.html">Fence</a>}</span></h4>
    

    



<div class="description">
    该函数用来产生一个围栏的对象
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            
            </td>

            

            

            <td class="description last">[{x:0, y:0},{x:12, y:12}, {x:24, y:0}, {x:0, y:0}] 围栏底面的路径信息，注意该数组第一个和最后一个元素坐标必须相同才能构成封闭的多边形。且元素长度至少为4</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minZ</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxZ</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>parameters</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">可选参数
parameters = {colorHex: 0x121223, opacity: 0.8, disableBottomPlane: false, disableTopPlane: true };
colorHex: 16进制数表示的颜色   opacity代表透明度,1表示不透明，介于0-1之间表示透明.  disableBottomPlane: false表示不禁用底面， true表示禁用底面，即底面不显示。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    fence对象，该对象上将会有 setVisibility(enable) 和 remove() 方法，分别控制围栏在场景中的显示和隐藏，以及移除该围栏。
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Fence.html">Fence</a></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="createHeatmap"><span class="type-signature"></span>createHeatmap<span class="signature">(parameters)</span><span class="type-signature"> &rarr; {Heatmap}</span></h4>
    

    



<div class="description">
    创建三维热力图
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parameters</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>center</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">热力图的中心点位置</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">热力图的宽度 单位：米</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>length</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">热力图的长度 单位：米</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>widthSegs</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">横向几何单位数量，该值越大则波峰和波谷过度越平滑，但是会消耗更多内存和渲染的资源</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lengthSegs</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">纵向几何单位数量，该值越大则波峰和波谷过度越平滑，但是会消耗更多内存和渲染的资源</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>heightRatio</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">热力图拉伸高度比例</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>radius</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">热力图单位数据点的绘制半径 单位：像素</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>resolutionX</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">生成热力图的横向分辨率，必须为2的整数幂次，该值越高则绘制的热力图越精细，但是会消耗更多的内存和渲染资源</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>resolutionY</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">生成热力图的纵向分辨率，必须为2的整数幂次，该值越高则绘制的热力图越精细，但是会消耗更多的内存和渲染资源</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>max</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">设定热力图数据源中的最大值，该值和最终生成的热力点颜色相关</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            
            </td>

            

            

            <td class="description last">[ ... { x, y, value } ] 热力图的数据源，包含xy位置以及value，x/y的值为0~1的小数，表示该数据点在热力图的宽、长范围内的比例，注意以数组形式传入</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Heatmap</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="createNavCube"><span class="type-signature"></span>createNavCube<span class="signature">(domElement, cssStyle)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    创建引擎的导航指示器
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>domElement</code></td>
            

            <td class="type">
            
                
<span class="param-type">DOM</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>cssStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createQRCode"><span class="type-signature"></span>createQRCode<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    创建二维码对象
调用该函数后，二维码模型会跟着鼠标移动，当鼠标左键点击后，二维码模型会被放置，同时触发 BIMRUN.Events.QRCodeChanged 的事件。
监听该事件的回调函数中，会被传入 二维码模型对象，二维码坐标(position)，二维码法向量(normal)，二维码旋转量(quaternion)
<br>你可以在回调函数中将二维码对象加入到你的队列中去保存该对象，用来后面的旋转，平移，显示和隐藏，以及删除该二维码对象
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="createSceneGridlines"><span class="type-signature"></span>createSceneGridlines<span class="signature">(sceneId, levelsId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    在场景中创建轴线
注意：你需要先调用加载轴线字体的方法，在加载成功之后会返回promise对象，在promise.then方法中调用该方法
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>levelsId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">levelId，注意以数组形式传入, 如果不传，则创建该sceneId场景下所有的标高对应的轴线</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="deleteAllClippingPlanes"><span class="type-signature"></span>deleteAllClippingPlanes<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除裁剪平面
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="deleteDom"><span class="type-signature"></span>deleteDom<span class="signature">(dom)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除css2drenderer 的dom元素
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>dom</code></td>
            

            <td class="type">
            
                
<span class="param-type">DOM</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="deleteHeatmap"><span class="type-signature"></span>deleteHeatmap<span class="signature">(heatmap)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除热力图
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>heatmap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Heatmap</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="deleteQRCode"><span class="type-signature"></span>deleteQRCode<span class="signature">(QRCodeObject)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据传入的二维码模型对象，删除该二维码模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>QRCodeObject</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">二维码模型对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="deleteSpritesSubContainer"><span class="type-signature"></span>deleteSpritesSubContainer<span class="signature">(spriteContainer)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除点精灵容器
该点精灵容器下的sprites也将会全部删除
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>spriteContainer</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">由addSpritesSubContainer方法所产生的的对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="detachTransformControls"><span class="type-signature"></span>detachTransformControls<span class="signature">(object)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    解除3D对象的控制器，操纵柄将会消失，同时失去都链接物体的操控
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>object</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">自定义的三维对象，包括二维码对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="displayAllClippingPlanes"><span class="type-signature"></span>displayAllClippingPlanes<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    隐藏裁剪平面
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="displayProject"><span class="type-signature"></span>displayProject<span class="signature">(projectId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据项目id展示项目，如果该项目id对应的项目还没有加载过，则不会显示
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>projectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="disPlayProject"><span class="type-signature"></span>disPlayProject<span class="signature">(projectId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据项目id显示项目
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>projectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>从v3.7版本开始已经被弃用，该api弃用是因为disPlay大小写拼写错误,推荐使用viewer.displayScene</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="displayScene"><span class="type-signature"></span>displayScene<span class="signature">(sceneId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据sceneId显示场景,如果该sceneId对应的场景还没有加载过，则什么都不会显示，此时你需要先调用一下loadScene方法
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="disPlayScene"><span class="type-signature"></span>disPlayScene<span class="signature">(sceneId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据场景id展示场景
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>从v3.7版本开始已经被弃用，该api弃用是因为disPlay大小写拼写错误,推荐使用viewer.displayScene</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="enableDragSelection"><span class="type-signature"></span>enableDragSelection<span class="signature">(enabled)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    切换开启框选模式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">传入true或false控制框选模式是否开启</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="enableGridlineMouseHover"><span class="type-signature"></span>enableGridlineMouseHover<span class="signature">(enable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置鼠标在悬停在轴线上时是否显示样式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">true则设置为悬停时显示样式</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="enableSnapping"><span class="type-signature"></span>enableSnapping<span class="signature">(enabled)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    切换开启顶点边线吸附模式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">传入true或false控制顶点边线吸附模式是否开启</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="enterDragSelectionMode"><span class="type-signature"></span>enterDragSelectionMode<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    进入框选模式
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="enterMeasureMode"><span class="type-signature"></span>enterMeasureMode<span class="signature">(sphereRadius, sphereColor, lineColor, txtColor, precision, unit)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    进入测距模式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sphereRadius</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>sphereColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">{ 示例：0x121212 }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lineColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">{ 示例：0x121212 }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>txtColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">{ 示例：0x121212 }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>precision</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">{ 精度（保留小数点后几位），示例：2}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>unit</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">{ 设置测距单位，示例：'m' }</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="filterModels"><span class="type-signature"></span>filterModels<span class="signature">(callbackfn)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>>}</span></h4>
    

    



<div class="description">
    利用回调函数来过滤模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callbackfn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">示例：传入function (BimrunSceneModel) { return BimrunSceneModel.customMaterial }可获取目前所有设置过自定义材质的模型</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="flyTo"><span class="type-signature"></span>flyTo<span class="signature">(cameraInfo, duration)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    相机飞向一个指定的相机位置和朝向（ cameraInfo ）
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>cameraInfo</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">示例：{ position: {x:1.0, y: 1.0, z: 1.0}, target: {x: 0.0, y: 0.0, z: 0.0} }</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选) 单位：ms  默认值： 2000ms</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="flyToBox"><span class="type-signature"></span>flyToBox<span class="signature">(box, duration)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Fly to a THREE.Box3, if the camera is in the bounding sphere, will only perform rotate lookat.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>box</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">示例：{min:{x: 1.0, y: 1.0,z: 1.0 }, max:{x: 2.0, y: 2.0, z: 2.0}} 或者是通过getSceneBox等API返回的box都可传入</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选)动画时间 单位：ms 默认值： 2000ms</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="flyToModel"><span class="type-signature"></span>flyToModel<span class="signature">(model, duration)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    相机飞向一个模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="BimrunSceneModel.html">BimrunSceneModel</a></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选) 单位：ms  默认值： 2000ms</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="flyToPoint"><span class="type-signature"></span>flyToPoint<span class="signature">(point, duration, awayDistance)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Fly to the point, with smooth duration defined. The controls will be disabled in the mean time.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{x:1, y: 1, z: 1}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选) 设置自定义动画的时长 单位：ms，默认值：2000ms</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>awayDistance</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选) 设置相机是否飞向距离目的地一定距离的点，默认值：0</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="flyToPositionTarget"><span class="type-signature"></span>flyToPositionTarget<span class="signature">(targetPosition, targetLookat, duration)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Set camera to the potision and look to the target, with smooth animation duration defined.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>targetPosition</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">示例： {x: 1.0, y: 1.0, z: 1.0}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>targetLookat</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">示例： {x: 1.0, y: 1.0, z: 1.0}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选）设置动画时间长度 单位：ms 
<br> 默认值 2000ms</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getAllModels"><span class="type-signature"></span>getAllModels<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>>}</span></h4>
    

    



<div class="description">
    获取所有的模型 (v3.7 添加)
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    models
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getCameraInfo"><span class="type-signature"></span>getCameraInfo<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    获取相机的信息，包括相机位置和朝向
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    { position: {x: 1.0, y: 1.0, z: 1.0}, target: {x: 0.0, y: 0.0, z: 0.0} }
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getCanvasNDCoords"><span class="type-signature"></span>getCanvasNDCoords<span class="signature">(input)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    根据输入的2/3维坐标对象，获取引擎Canvas中的平面NDC坐标
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>input</code></td>
            

            <td class="type">
            
                
<span class="param-type">Event</span>
|

<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{ x: float, y: float, [z: float] } </br>若该参数只包含x，y属性则会当做MouseEvent处理并转化为Canvas内的平面坐标；</br>若该参数包含x，y，z属性则会当做三维空间坐标点来获取到Canvas内的平面坐标。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    { x: float[-1, 1], y: float[-1, 1] }
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getCustomColorModels"><span class="type-signature"></span>getCustomColorModels<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>>}</span></h4>
    

    



<div class="description">
    获取有自定义颜色的模型（数组）
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getExtentsProjectionArea"><span class="type-signature"></span>getExtentsProjectionArea<span class="signature">(extents)</span><span class="type-signature"> &rarr; {Number}</span></h4>
    

    



<div class="description">
    获取长宽高为extents的包围盒的最大投影面积
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>extents</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">包围盒的长宽高，如 {x: 10, y: 10, z: 10}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    返回包围盒的最大投影面积数值
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getGroups"><span class="type-signature"></span>getGroups<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    getGroups
</div>













<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>自v3.7已经弃用，推荐使用XXX</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    { 0: {models: models }}
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getHiddenModels"><span class="type-signature"></span>getHiddenModels<span class="signature">()</span><span class="type-signature"> &rarr; {Array}</span></h4>
    

    



<div class="description">
    获取当前所有被隐藏的模型，返回值为模型数组
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    返回值为模型数组
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getInspectionData"><span class="type-signature"></span>getInspectionData<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    获取Viewer的监控数据
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    data
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getModelById"><span class="type-signature"></span>getModelById<span class="signature">(modelId)</span><span class="type-signature"> &rarr; {<a href="BimrunSceneModel.html">BimrunSceneModel</a>}</span></h4>
    

    



<div class="description">
    根据模型id来获取模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelId</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>
|

<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    model
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="BimrunSceneModel.html">BimrunSceneModel</a></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getModelsBox"><span class="type-signature"></span>getModelsBox<span class="signature">(modelIds)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    获取模型的包围盒
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;id></span>


            
            </td>

            

            

            <td class="description last">以数组形式传入的modelIds</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Model Box
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getModelsBySceneId"><span class="type-signature"></span>getModelsBySceneId<span class="signature">(sceneId)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>>}</span></h4>
    

    



<div class="description">
    通过场景Id来获取models
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    models
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getNodes"><span class="type-signature"></span>getNodes<span class="signature">(sceneId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据场景id获得该场景下的node
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">12313 或者 "12313"</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>自v3.7已经弃用，推荐使用getModelBySceneId(sceneId) 或者 XXX</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="getScenesBox"><span class="type-signature"></span>getScenesBox<span class="signature">(ids)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    获取场景或者项目的包围盒，支持多场景多项目的获取
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ids</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;ids></span>


            
            </td>

            

            

            <td class="description last">(可选) [sceneIds] 或者 [projectIds] 注意：是以数组形式传入，若传入undefined或不传则返回全场景的包围盒</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    box3
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getScreenshot"><span class="type-signature"></span>getScreenshot<span class="signature">(width, height)</span><span class="type-signature"> &rarr; {DataURL}</span></h4>
    

    



<div class="description">
    获取截图
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">DataURL</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getSelectedModels"><span class="type-signature"></span>getSelectedModels<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>>}</span></h4>
    

    



<div class="description">
    获取当前选中的模型
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getTotalSceneBox"><span class="type-signature"></span>getTotalSceneBox<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    获取总场景的包围盒
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    box
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="hideModels"><span class="type-signature"></span>hideModels<span class="signature">(models)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    隐藏模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>models</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


            
            </td>

            

            

            <td class="description last">[models] 注意以数组形式传入</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hideModelsById"><span class="type-signature"></span>hideModelsById<span class="signature">(modelIds)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据多个modelId隐藏模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;int></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hideProject"><span class="type-signature"></span>hideProject<span class="signature">(projectId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据项目id隐藏场景
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>projectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hideQRCode"><span class="type-signature"></span>hideQRCode<span class="signature">(QRCodeObject)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据传入的二维码模型对象，来隐藏二维码模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>QRCodeObject</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">二维码模型对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hideScene"><span class="type-signature"></span>hideScene<span class="signature">(sceneId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据场景id隐藏场景
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hideSceneGridlines"><span class="type-signature"></span>hideSceneGridlines<span class="signature">(sceneId, levelsId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    隐藏场景下与标高对应的轴线信息
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>levelsId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">levelId，注意以数组形式传入, 如果不传levelId，则隐藏该sceneId场景下所有的标高对应的轴线</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="hideSelection"><span class="type-signature"></span>hideSelection<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    隐藏当前选中的所有模型
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="isDragSelectionOn"><span class="type-signature"></span>isDragSelectionOn<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
    

    



<div class="description">
    获取当前是否开启了框选模式
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isInFence"><span class="type-signature"></span>isInFence<span class="signature">(fence, point)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
    

    



<div class="description">
    该函数传入一个围栏对象和一个三维中的点，用来判断点是否在围栏内
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>fence</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">即使用createFence产生的对象</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{x:0, y:0, z:0} 表示三维中的一个点</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    true代表点在围栏内（包括在围栏边上）， false代表点不在围栏内
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isSnappingOn"><span class="type-signature"></span>isSnappingOn<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
    

    



<div class="description">
    获取当前是否开启了顶点边线吸附模式
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="leaveDragSelectionMode"><span class="type-signature"></span>leaveDragSelectionMode<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    退出框选模式
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="leaveMeasureMode"><span class="type-signature"></span>leaveMeasureMode<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    退出测距模式
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="listen"><span class="type-signature"></span>listen<span class="signature">(type, fn)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    添加监听事件（optional）
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">BIMRUN.Events下定义的事件类型 或者 用户自定义类型</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">回调函数</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>自v3.7版本起已经弃用。推荐使用 addEventListener api</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(parameters)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    加载模型 (BIMRUN project/scene)
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parameters</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{ loadTexture: Boolean, useNativeBox: Boolean, server: String, id: String || number, type: String, onProgressCallback: Function }
</br>
type 参数接收 "sceneId" || "projectId" 作为参数</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="loadGridlineFont"><span class="type-signature"></span>loadGridlineFont<span class="signature">(url)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
    

    



<div class="description">
    加载轴网字体，也就是轴线两端平面圆中对应的符号，如A，1等
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">字体文件资源的地址</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    返回promise对象，字体文件加载返回promise对象，成功数据将返回success，否则返回error，注意你需要在.then方法中去创建轴线，即createSceneGridlines 或者 createCustomGridlines方法
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="loadManifestData"><span class="type-signature"></span>loadManifestData<span class="signature">(data, id, type)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    直接加载Manifest json数据
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="loadProject"><span class="type-signature"></span>loadProject<span class="signature">(projectId, disableAnimation, onProgressCallback, version)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据项目id加载项目数据至引擎，包含飞向项目的动画,可通过第二个参数来禁用动画
<br>注意：对于已经加载的projectId，将会报出warning,不会重复加载。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>projectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">若需要包含版本信息，则在id后加上字符串".{版本号}"，例如'3021430.22'</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableAnimation</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">(可选)默认为false,即开启动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>onProgressCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">(可选)回调函数，该回调函数的参数为进度值，范围（0 - 1）</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>version</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">(可选)版本号，如果传入版本号，则在请求manifest文件时会走浏览器默认缓存</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="loadQRCodeImage"><span class="type-signature"></span>loadQRCodeImage<span class="signature">(imgSrc)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    加载二维码的图片，注意场景中所有的二维码模型的样式样式都会共享这张图片
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>imgSrc</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">二维码模型图片资源地址</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="loadScene"><span class="type-signature"></span>loadScene<span class="signature">(sceneId, disableAnimation, onProgressCallback, version)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据场景id加载场景数据至引擎，包含飞向场景的动画,可通过第二个参数来禁用动画
<br>注意：对于已经加载的sceneId，将会报出warning,不会重复加载。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">若需要包含版本信息，则在id后加上字符串".{版本号}"，例如'3021430.22'</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableAnimation</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">(可选) 默认为false,即开启动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>onProgressCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">（可选）回调函数，该回调函数的参数为进度值，范围（0 - 1）</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>version</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">(可选)版本号，如果传入版本号，则在请求manifest文件时会走浏览器默认缓存</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="loadScenePromises"><span class="type-signature"></span>loadScenePromises<span class="signature">(sceneIds, parameters)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
    

    



<div class="description">
    使用Promise.all的方式去加载多个场景id，返回一个异步加载完成的Promise对象。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;id></span>


            
            </td>

            

            

            <td class="description last">注意以数组形式传入的sceneId, 若需要包含版本信息，则在id后加上字符串".{版本号}"，例如'3021430.22'</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>parameters</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>server</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">服务器地址</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableAnimation</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">是否禁用引擎加载后的镜头飞至场景的动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>onProgressCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">加载场景进度的回调函数</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>version</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">(可选)版本号，如果传入版本号，则在请求manifest文件时会走浏览器默认缓存</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="lookToPoint"><span class="type-signature"></span>lookToPoint<span class="signature">(point, duration)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    Look to the target point without changing the camera position, with smooth duration defined.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">示例：{x: 1.0, y: 1.0, z: 1.0}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">(可选) 单位：ms   默认值： 2000ms</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="pickModel"><span class="type-signature"></span>pickModel<span class="signature">(event)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    



<div class="description">
    通过鼠标事件获取与场景中模型的交点和交点模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">Event</span>


            
            </td>

            

            

            <td class="description last">鼠标在Canvas上的事件 MouseEvent</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="pickModelType"><span class="type-signature"></span>pickModelType<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    获取与当前选中模型familyTypeId相同的所有构件，并将它们都选中
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removeAllGridlines"><span class="type-signature"></span>removeAllGridlines<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除所有的轴线信息
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removeCustomObject"><span class="type-signature"></span>removeCustomObject<span class="signature">(obj)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除用户自定义模型
<br> <b>注意：该方法也可以用来删除包括addCustomBasicLine()方法以及addCustomBasicLine()生成的线条</b>
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
                
<span class="param-type">THREE.Object3D</span>


            
            </td>

            

            

            <td class="description last">已添加的CustomObject</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removeParticleEffects"><span class="type-signature"></span>removeParticleEffects<span class="signature">(particleEffects)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除粒子效果
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>particleEffects</code></td>
            

            <td class="type">
            
                
<span class="param-type">BIMRUN.ParticleSystem.ParticleEffect</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="removeSceneGridlines"><span class="type-signature"></span>removeSceneGridlines<span class="signature">(sceneId, levelsId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    删除场景下与标高对应的轴线信息
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>levelsId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">levelId，注意以数组形式传入, 如果不传levelId，则删除该sceneId场景下所有的标高对应的轴线</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="render"><span class="type-signature"></span>render<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    强制引擎刷新一次(引擎通常在画面静止时停止刷新，省电)
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="resizeWindow"><span class="type-signature"></span>resizeWindow<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据目前的Canvas的大小，调整引擎的可视范围大小到合适的状态。
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="rotateQRCode"><span class="type-signature"></span>rotateQRCode<span class="signature">(QRCodeObject, angle)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据角度来旋转二维码模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>QRCodeObject</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">二维码模型对象</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>angle</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">角度值，如 80, 代表旋转80度</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setCamera"><span class="type-signature"></span>setCamera<span class="signature">(cameraInfo)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    改变相机的位置和朝向
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>cameraInfo</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{ position: {x:1.0, y: 1.0, z: 1.0}, target: {x: 0.0, y: 0.0, z: 0.0} }</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setCameraLookat"><span class="type-signature"></span>setCameraLookat<span class="signature">(x, y, z)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    改变相机的朝向（不改变相机位置）
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>z</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setCameraPosition"><span class="type-signature"></span>setCameraPosition<span class="signature">(x, y, z)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    改变相机的位置（不改变相机朝向）
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>z</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setControlParameter"><span class="type-signature"></span>setControlParameter<span class="signature">(parameterName, value)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置引擎鼠标和触控操控的一些参数
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parameterName</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">参数名称，字符串，可能的名称：<br/>
'AUTO_ROTATE_SPEED' 默认值：(1 / 180 * Math.PI) Rad, <br/>
'DEFAULT_INTERSECT_DEPTH' 默认值：10, <br/>
'LOOKAROUND_SPEED' 默认值：2, <br/>
'ROTATE_SPEED_X' 默认值：5, <br/>
'ROTATE_SPEED_Y' 默认值：5, <br/>
'TOUCH_ROTATE_THRESHOLD' 默认值：0 Rad, <br/>
'TOUCH_ZOOM_THRESHOLD' 默认值：1500, <br/>
'ZOOM_ANIMATION_MS' 默认值：250, <br/>
'ZOOM_MAX_SPEED' 默认值：50, <br/>
'ZOOM_MIN_SPPED' 默认值：0.01, <br/>
'ZOOM_SPEED' 默认值：0.03, <br/>
'rotateBySelectedCenter' 默认值：true, <br/></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Any</span>


            
            </td>

            

            

            <td class="description last">参数的目标值</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setGridlineOnTop"><span class="type-signature"></span>setGridlineOnTop<span class="signature">(sceneId, levelsId, enable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置该场景下与标高对应的轴线透视效果
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>levelsId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">levelId，注意以数组形式传入, 如果不传levelId，则将该sceneId场景下所有的标高对应的轴线设置为透视效果,如果不传入levelId，则应该传入undefined</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">true则设置为透视效果</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setIsolate"><span class="type-signature"></span>setIsolate<span class="signature">(enabled)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    是否设置隔离模式，选中模型将不会受到隔离模式效果（透明效果）影响
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setLuminosity"><span class="type-signature"></span>setLuminosity<span class="signature">(value)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置场景的光照强度
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">范围是：(0.0 ~ 1.0)</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setModelsCustomColor"><span class="type-signature"></span>setModelsCustomColor<span class="signature">(modelIds, color, opacity, imgUrl)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置模型的自定义颜色
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;modelId></span>


            
            </td>

            

            

            <td class="description last">注意这里是使用modelId，以数组形式传入</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">十六进制形式 例如：0xffffff</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>opacity</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">范围:(0-1)</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>imgUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">图像地址</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setModelsCustomMaterial"><span class="type-signature"></span>setModelsCustomMaterial<span class="signature">(modelIds, material)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    为模型设置指定的material
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;modelId></span>


            
            </td>

            

            

            <td class="description last">注意这里传入的是modelId形式的数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>material</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setOutlineHiddenColor"><span class="type-signature"></span>setOutlineHiddenColor<span class="signature">(colorHex)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置被选中物体的轮廓颜色，该颜色是<b>被其他模型遮挡部分</b>的颜色
<br>注意：调用该方法前，需要在初始化viewer时设置useOutline参数
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>colorHex</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">十六进制形式表示的number 示例：0x3371cd</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setOutlineStrength"><span class="type-signature"></span>setOutlineStrength<span class="signature">(strength)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置被选中物体的轮廓亮度
<br>注意：调用该方法前，需要在初始化viewer时设置useOutline参数
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>strength</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">示例：1~10，数值越大，轮廓越亮越明显</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setOutlineThickness"><span class="type-signature"></span>setOutlineThickness<span class="signature">(thickness)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置被选中物体的轮廓宽度（厚度）
<br>注意：调用该方法前，需要在初始化viewer时设置useOutline参数
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>thickness</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">示例：1~10，数值越大，轮廓越厚</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setOutlineVisibleColor"><span class="type-signature"></span>setOutlineVisibleColor<span class="signature">(colorHex)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置被选中物体的轮廓颜色，该颜色是<b>没有被其他模型遮挡部分</b>的颜色
<br>注意：调用该方法前，需要在初始化viewer时设置useOutline参数
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>colorHex</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">十六进制形式表示的number 示例：0x3371cd</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setQRCodeOffset"><span class="type-signature"></span>setQRCodeOffset<span class="signature">(distance)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置二维码距离墙体的距离，默认是0.004,也就是4毫米的距离
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>distance</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">二维码距离墙面的距离，单位默认是m</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setSceneBackGroundColor"><span class="type-signature"></span>setSceneBackGroundColor<span class="signature">(colorValue)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置场景的背景颜色
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>colorValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">{ 示例：0x121212 }</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>后续版本中将弃用，推荐使用 Viewer.setSceneBackgroundColor()</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setSceneBackgroundColor"><span class="type-signature"></span>setSceneBackgroundColor<span class="signature">(colorValue)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置场景的背景颜色
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>colorValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">{ 示例：0x121212 }</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setSceneBackGroundTexture"><span class="type-signature"></span>setSceneBackGroundTexture<span class="signature">(imageUrl)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置场景的背景图片
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>imageUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">{ 背景图片的地址 }</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>后续版本中将弃用，推荐使用 Viewer.setSceneBackgroundTexture()</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setSceneBackgroundTexture"><span class="type-signature"></span>setSceneBackgroundTexture<span class="signature">(imageUrl)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置场景的背景图片
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>imageUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">{ 背景图片的地址 }</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setSceneSelected"><span class="type-signature"></span>setSceneSelected<span class="signature">(sceneId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据场景id来选中该场景下的所有模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setTransformControlsAxis"><span class="type-signature"></span>setTransformControlsAxis<span class="signature">(xAxis, yAxis, zAxis)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    显示或隐藏3D对象的控制器的操纵柄的三维控制轴，包括x,y,z轴
<br> x,y,z轴的显示或隐藏在平移模式或者旋转模式下都可以使用。
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>xAxis</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否显示或隐藏x轴</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>yAxis</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否显示或隐藏y轴</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zAxis</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否显示或隐藏z轴</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setTransformControlsMode"><span class="type-signature"></span>setTransformControlsMode<span class="signature">(mode)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置3D对象的控制器模型，包括旋转和平移两种模式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>mode</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">目前仅支持两种模式，mode=”translate“表示该控制器可以控制物体的平移，mode="rotate"表示该控制器可以控制物体的旋转。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setUseGravity"><span class="type-signature"></span>setUseGravity<span class="signature">(enabled)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    是否使用重力漫游，仅仅在键盘按键(W\S)时有效
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setViewport"><span class="type-signature"></span>setViewport<span class="signature">(position, quaternion, lookat)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置相机的位置和朝向，有动画过程
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{x: 1.0, y: 1.0, z: 1.0}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>quaternion</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{x: 1.0, y: 1.0, z: 1.0, w: 1.0}</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lookat</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">{x: 1.0, y: 1.0, z: 1.0}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>自v3.7已经弃用，推荐使用viewer.flyToPositionTarget(position, lookat, duration)</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="showClippingPlaneCap"><span class="type-signature"></span>showClippingPlaneCap<span class="signature">(enable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    是否显示的背面材质渲染，也就是剖面的纹理是否需要填充效果
可以通过 new Viewer时，以参数renderClipCap=true来开启（默认时关闭的）
<br>也可以通过使用该api来手动切换是否开启
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">是否开启剖面纹理填充效果, true表示开启</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="showGroup"><span class="type-signature"></span>showGroup<span class="signature">(sceneId, enabled)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据场景id隐藏或者显示该场景id下的models
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">121121 或者 "121121"</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">true:显示该sceneId对于的models</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>自v3.7已经弃用，推荐使用displayScene(sceneId) 或者 hideScene(sceneId)</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="showModels"><span class="type-signature"></span>showModels<span class="signature">(models<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    显示模型
自v3.7开始，事件触发名称，由原来的ShowAllModels 改为 ShowModels，该事件已经已经弃用
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>models</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {undefined}
                
                </td>
            

            <td class="description last">[models] 注意以数组形式传入，若不传入或传入null，则显示所有模型</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="showModelsById"><span class="type-signature"></span>showModelsById<span class="signature">(modelIds)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    通过modelIds显示模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">[modelIds] 注意以数组形式传入</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="showProject"><span class="type-signature"></span>showProject<span class="signature">(projectId, value)</span><span class="type-signature"> &rarr; {Number}</span></h4>
    

    



<div class="description">
    根据projectId显示或隐藏项目,如果该projectId对应的项目还没有加载，则该函数会自动调用loadProject，然后再显示项目。
<br> 注意：该函数对不同的情况将会有不同的返回值
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>projectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">如果传入true，则显示项目，否则就是隐藏项目</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    返回1代表对已经加载的项目显示成功，返回0表示该项目未加载将使用loadProject进行加载并显示
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="showQRCode"><span class="type-signature"></span>showQRCode<span class="signature">(QRCodeObject)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据传入的二维码模型对象，来显示二维码模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>QRCodeObject</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">二维码模型对象</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="showScene"><span class="type-signature"></span>showScene<span class="signature">(sceneId, value, version, disableAnimation, onProgressCallback)</span><span class="type-signature"> &rarr; {Number}</span></h4>
    

    



<div class="description">
    根据sceneId显示或隐藏场景,如果该sceneId对应的场景还没有加载，则该函数会自动调用loadScene，然后再显示场景。
<br> 注意：该函数对不同的情况将会有不同的返回值
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">如果传入true，则显示场景，否则就是隐藏场景,该参数仅在sceneId对应的场景已加载时起作用</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>version</code></td>
            

            <td class="type">
            
                
<span class="param-type">Int</span>


            
            </td>

            

            

            <td class="description last">(可选)版本号，如果传入版本号，则在请求manifest文件时会走浏览器默认缓存，该参数仅在sceneId对应的场景未加载时起作用</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableAnimation</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">(可选) 默认为false,即开启动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>onProgressCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">（可选）回调函数，该回调函数的参数为进度值，范围（0 - 1）</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    返回1代表对已经加载的场景显示成功，返回0表示该场景未加载将使用loadScene进行加载并显示
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="showSceneGridlines"><span class="type-signature"></span>showSceneGridlines<span class="signature">(sceneId, levelsId)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    显示场景下与标高对应的轴线信息
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>levelsId</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Number></span>


            
            </td>

            

            

            <td class="description last">levelId，注意以数组形式传入, 如果不传levelId，则显示该sceneId场景下所有的标高对应的轴线</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="switchRenderSide"><span class="type-signature"></span>switchRenderSide<span class="signature">(doubleSided)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    切换渲染材质的单面或者双面
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>doubleSided</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="switchRotateAround"><span class="type-signature"></span>switchRotateAround<span class="signature">(enabled, speed)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    切换自动环顾四周
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">如果为true，相机自动旋转，环顾四周</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>speed</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="translateQRCode"><span class="type-signature"></span>translateQRCode<span class="signature">(QRCodeObject, x, y)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据传入的二维码模型对象和x,y值， 在二维码模型的x轴和y轴来移动x,y的距离
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>QRCodeObject</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">二维码模型对象</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">在二维码模型坐标系的x轴的移动距离，如 0.1，代表0.1米</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">在二维码模型坐标系的y轴的移动距离，如 0.1，代表0.1米</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="unlisten"><span class="type-signature"></span>unlisten<span class="signature">(type, listener)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    取消事件监听（optional）
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>listener</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>viewer.removeEventListener( type, fn );</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="unSelect"><span class="type-signature"></span>unSelect<span class="signature">(sceneModels)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    取消模型的选中样式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sceneModels</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="BimrunSceneModel.html">BimrunSceneModel</a>></span>


            
            </td>

            

            

            <td class="description last">以数组形式传入的模型列表</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="updateDomPosition"><span class="type-signature"></span>updateDomPosition<span class="signature">(dom, position)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    更新 css2drenderer 的dom元素位置
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>dom</code></td>
            

            <td class="type">
            
                
<span class="param-type">DOM</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">示例：{x: 1.0, y: 1.0, z: 1.0}</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="updateModelWeights"><span class="type-signature"></span>updateModelWeights<span class="signature">(models, weights)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
    

    



<div class="description">
    更新模型的权重，模型的权重越大，那么该模型可以在更远的距离被看见
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>models</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">需要修改权重的模型数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>weights</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">权重数组，number，数组长度需要与模型数组长度一致</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    操作成功返回true
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="updatePickSprite"><span class="type-signature"></span>updatePickSprite<span class="signature">(size, imgUrl)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置zoom时，在鼠标处显示的sprite样式
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>size</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">sprite大小</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>imgUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">图片的地址 
<br> 使用示例： viewer.updatePickSprite(size, imgUrl)</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="viewModel"><span class="type-signature"></span>viewModel<span class="signature">(modelIds, projectId, distance)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据projectId，根据传入的模型Id，来加载距离这些模型distance范围内的所有模型
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>modelIds</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">模型的id数组</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>projectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            

            

            <td class="description last">项目id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>distance</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last">距离，单位：m</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="viewProject"><span class="type-signature"></span>viewProject<span class="signature">(projectId, disableAnimation, onProgressCallback)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    根据项目id加载场景
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>projectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">若需要包含版本信息，则在id后加上字符串".{版本号}"，例如'3021430.22'</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableAnimation</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">（可选）默认为false,即开启动画</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>onProgressCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">（可选) 回调函数，该回调函数的参数为进度值，范围（0 - 1）</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>自v3.7版本已弃用，建议使用 viewer.loadProject(projectId, disableAnimation, onProgressCallback)</li></ul></dd>
    

    

    

    

    

    

    

    

    
</dl>




















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BimrunSceneModel.html">BimrunSceneModel</a></li><li><a href="EnvEffectsPlugin.html">EnvEffectsPlugin</a></li><li><a href="Fence.html">Fence</a></li><li><a href="HeatmapPlugin-Heatmap.html">Heatmap</a></li><li><a href="SpritePlugin-BimrunSprite.html">BimrunSprite</a></li><li><a href="SpritePlugin-SpriteContainer.html">SpriteContainer</a></li><li><a href="Viewer.html">Viewer</a></li><li><a href="WalkThroughPlugin.html">WalkThroughPlugin</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Events">Events</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Wed May 26 2021 13:42:33 GMT+0800 (中国标准时间)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>